/**
 * # 参数列表实体类:
 *  List - 用户列表
 * 
 * # 描述:
 *  查询并显示系统中已经注册的所有用户。
 *  
 * Copyright (c), 上海沃恩信息科技有限公司.
 * All rights reserved.
 * Licensed under BSD (https://www.pittypat.work/bsd.html).
 */

package com.waln.authority.users.args;

/**
 * 功能 用户列表 的参数列表。
 */
@pittypat.FunctionAnnotation(transaction = false)
public final class List extends pittypat.FunctionArgs {
	/**
	 * 页码。
	 */
	@pittypat.ParameterAnnotation(position = 0, role = pittypat.ParameterRole.PAGE_INDEX)
	public Long pageIndex;

	/**
	 * 页面尺寸。
	 */
	@pittypat.ParameterAnnotation(position = 1, role = pittypat.ParameterRole.PAGE_SIZE)
	public Long pageSize;

	/**
	 * 总行数。
	 */
	@pittypat.ParameterAnnotation(position = 2, direction = pittypat.ParameterDirection.OUT, role = pittypat.ParameterRole.TOTAL_ROWS)
	public Long totalRows;

	/**
	 * 排序名称。
	 */
	@pittypat.ParameterAnnotation(position = 3, role = pittypat.ParameterRole.ORDER_NAME, maxLength = 30)
	public String orderName;

	/**
	 * 排序方向。
	 */
	@pittypat.ParameterAnnotation(position = 4, role = pittypat.ParameterRole.ORDER_DIRECTION, maxLength = 4)
	public String orderDirection;

	/**
	 * 用户 Id。
	 * <p>
	 * 当前用户的 Id，由系统自动设置该参数。
	 */
	@pittypat.ParameterAnnotation(position = 5, role = pittypat.ParameterRole.USER_ID)
	public java.util.UUID userId;

	/**
	 * 用户名称。
	 * <p>
	 * 用户的友好显示名称、登录名称或编号的全部或一部分。
	 */
	@pittypat.ParameterAnnotation(position = 6, maxLength = 50)
	public String name;

	/**
	 * 已锁定用户。
	 * <p>
	 * 查询已经锁定或者尚未锁定的用户。
	 */
	@pittypat.ParameterAnnotation(position = 7)
	public Boolean locked;

	/**
	 * 用户列表。
	 * <p>
	 * 符合条件的用户列表。
	 */
	@pittypat.ParameterAnnotation(position = 8, direction = pittypat.ParameterDirection.OUT)
	public pittypat.DataList<com.waln.authority.users.data.User> users;

	/**
	 * 初始化 List 类的一个新实例。
	 */
	public List() {
		super();

		// 页码
		this.pageIndex = null;
		// 页面尺寸
		this.pageSize = null;
		// 总行数
		this.totalRows = null;
		// 排序名称
		this.orderName = null;
		// 排序方向
		this.orderDirection = null;
		// 用户 Id
		this.userId = null;
		// 用户名称
		this.name = null;
		// 已锁定用户
		this.locked = null;
		// 用户列表
		this.users = null;
	}

	/**
	 * 获取指定名称的参数值。
	 * 
	 * @param name
	 * 			参数名称，不区分大小写。
	 * @return 指定名称的参数值。
	 */
	@Override
	public Object getParameterValue(String name) {
		if (name == null || name.length() == 0) {
			return null;
		}

		switch (name.toLowerCase()) {
			case "pageindex":
				return this.pageIndex;
			case "pagesize":
				return this.pageSize;
			case "totalrows":
				return this.totalRows;
			case "ordername":
				return this.orderName;
			case "orderdirection":
				return this.orderDirection;
			case "userid":
				return this.userId;
			case "name":
				return this.name;
			case "locked":
				return this.locked;
			case "users":
				return this.users;
			default:
				return null;
		}
	}

	/**
	 * 设置指定名称的参数值。
	 * 
	 * @param name
	 * 			参数名称，不区分大小写。
	 * @param value
	 * 			参数值。
	 * 
	 * @throws IllegalArgumentException
	 */
	@SuppressWarnings("unchecked")
	@Override
	public void setParameterValue(String name, Object value) throws IllegalArgumentException {
		if (name == null || name.length() == 0) {
			throw new IllegalArgumentException("没有提供有效的参数名称。");
		}

		switch (name.toLowerCase()) {
			case "pageindex":
				this.pageIndex = (Long) value;
				break;
			case "pagesize":
				this.pageSize = (Long) value;
				break;
			case "totalrows":
				this.totalRows = (Long) value;
				break;
			case "ordername":
				this.orderName = (String) value;
				break;
			case "orderdirection":
				this.orderDirection = (String) value;
				break;
			case "userid":
				this.userId = (java.util.UUID) value;
				break;
			case "name":
				this.name = (String) value;
				break;
			case "locked":
				this.locked = (Boolean) value;
				break;
			case "users":
				this.users = (pittypat.DataList<com.waln.authority.users.data.User>) value;
				break;
			default:
				throw new IllegalArgumentException(name + " 不是 " + this.getClass().getName() + " 的有效参数属性名称。");
		}
	}

	/**
	 * 将当前对象作为 JSON 字符串写入指定的文本流。
	 * 
	 * @param writer
	 * 			目标文本流。
	 * 
	 * @throws IllegalArgumentException
	 * @throws java.io.IOException
	 */
	@Override
	public void write(java.io.Writer writer) throws IllegalArgumentException, java.io.IOException {
		if (writer == null) {
			throw new IllegalArgumentException("writer 为 null。");
		}

		writer.write('{');

		// 页码
		writer.write("\"pageIndex\":");
		pittypat.Json.write(writer, this.pageIndex);
		writer.write(',');

		// 页面尺寸
		writer.write("\"pageSize\":");
		pittypat.Json.write(writer, this.pageSize);
		writer.write(',');

		// 总行数
		writer.write("\"totalRows\":");
		pittypat.Json.write(writer, this.totalRows);
		writer.write(',');

		// 排序名称
		writer.write("\"orderName\":");
		pittypat.Json.write(writer, this.orderName);
		writer.write(',');

		// 排序方向
		writer.write("\"orderDirection\":");
		pittypat.Json.write(writer, this.orderDirection);
		writer.write(',');

		// 用户 Id
		writer.write("\"userId\":");
		pittypat.Json.write(writer, this.userId);
		writer.write(',');

		// 用户名称
		writer.write("\"name\":");
		pittypat.Json.write(writer, this.name);
		writer.write(',');

		// 已锁定用户
		writer.write("\"locked\":");
		pittypat.Json.write(writer, this.locked);
		writer.write(',');

		// 用户列表
		writer.write("\"users\":");
		pittypat.Json.write(writer, this.users);

		writer.write('}');
	}
}
